/*
 * FreeRTOS V202212.00
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * https://www.FreeRTOS.org
 * https://github.com/FreeRTOS
 *
 */

#ifndef UART_DEMO_H_
#define UART_DEMO_H_

/* Standard includes. */
#include <stdint.h>

/**
 * @brief The function that implements the UART demo.
 *
 * It prints a command menu on the serial console and then waits for a task
 * notification. Whenever user enters any input on the serial console to run a
 * command, the UART received IRQ handler handles it and prints the appropriate
 * response on the serial console. The IRQ handler then unblocks the UART task
 * using task notification.
 */
void vUartDemoTask( void * pvParams );

/**
 * @brief Handler for the UART received IRQ.
 *
 * @param [in] ulData Data entered by the user.
 */
void vUartDataReceivedIRQHandler( uint32_t ulData );

#endif /* UART_DEMO_H_ */
